DOCSP-44687 export to playground with Copilot #103

ltran-mdb2 · 2024-12-04T16:25:39Z

DESCRIPTION

Users can now export code from their project files to a playground.

STAGING

https://deploy-preview-103--docs-mongodb-vscode.netlify.app/playgrounds/#create-a-new-playground
https://deploy-preview-103--docs-mongodb-vscode.netlify.app/copilot-export-test/
https://deploy-preview-103--docs-mongodb-vscode.netlify.app/export-to-language/#prerequisites

JIRA

https://jira.mongodb.org/browse/DOCSP-44687

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

External Review Requirements

What's expected of an external reviewer?

netlify · 2024-12-04T16:25:56Z

✅ Deploy Preview for docs-mongodb-vscode ready!

Name	Link
🔨 Latest commit	`1c48330`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongodb-vscode/deploys/67535fd5c33125000823ee70
😎 Deploy Preview	https://deploy-preview-103--docs-mongodb-vscode.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 42 (🟢 up 18 from production) Accessibility: 91 (no change from production) Best Practices: 75 (no change from production) SEO: 75 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

sarah-olson-mongodb

Thanks a ton @ltran-mdb2! LGTM with a couple minor style guide nits.

sarah-olson-mongodb · 2024-12-04T19:22:25Z

source/playgrounds.txt

+
+      1. Open a project file.
+
+         To open a file in |vscode-short|, click on the file name in the


(nit -- click)
You can usually drop on. There are a couple instances. I'll just mark this one.

Suggested change

To open a file in |vscode-short|, click on the file name in the

To open a file in |vscode-short|, click the file name in the

sarah-olson-mongodb · 2024-12-04T19:23:59Z

source/playgrounds.txt

+
+      #. Highlight the code that you want to open in a playground.
+
+      #. Right click to select :guilabel:`Export Code to Playground`.


(nit -- right-click)
Always hyphenate. There are a couple instances. I'll just mark this one.

GaurabAryal · 2024-12-05T16:18:31Z

source/playgrounds.txt


      .. include:: /includes/steps/open-new-playground.rst

+   .. tab:: Your Project File


@ltran-mdb2 I think this might best for this to live in it's own nav as it is a complimentary feature to "Export to Language". We could call it "Test Application Query" in the nav and make the title "Export and Test Application Query in Playgrounds".

Lastly, on both of them (i.e. Export to Language) - could we call out that these features are currently only available for users who have Github Copilot & MongoDB's Copilot extension enabled?

GaurabAryal · 2024-12-05T16:24:51Z

source/playgrounds.txt

+   .. tab:: Your Project File
+      :tabid: project-file
+
+      1. Open a project file.


Needs to be more specific, something like:
"Open your application project file that has the MongoDB query you want to export"

GaurabAryal · 2024-12-05T16:25:15Z

source/playgrounds.txt

+
+      1. Open a project file.
+
+         To open a file in |vscode-short|, click the file name in the


I think we can omit this part (fairly obvious for users who use the IDE)

GaurabAryal · 2024-12-05T16:26:18Z

source/playgrounds.txt

+         To open a file in |vscode-short|, click the file name in the
+         file explorer. 
+
+      #. Highlight the code that you want to open in a playground.


Here we should be specific about "highlighting the code of the query you want to test"

GaurabAryal · 2024-12-05T16:27:49Z

source/playgrounds.txt

+      #. Right-click to select :guilabel:`Export Code to Playground`.
+
+         Right-click your selected code to open the options menu.
+         Click :guilabel:`MongoDB Copilot Participant` >


In the immediate update coming up we're renaming this to "MongoDB Copilot Extension" instead of "Participant". Let's change it here so we don't have to amend shortly after.

GaurabAryal · 2024-12-05T16:30:02Z

source/playgrounds.txt

+         :guilabel:`Export Code to Playground`. 
+
+         When you click :guilabel:`Export Code to Playground`, |vscode-short|
+         opens a new playground with your selected code. 


Let's specify that this opens a new MongoDB playground file with your query exported to MongoDB Shell syntax. You can then hit the run button in the top left corner to test this query with the cluster you are currently connected to in your MongoDB extension. You can iterate on your query in the playgrounds until you are happy with your query. Once the query looks good to you, you can export it back to your application code by using the Export to Language feature (link to Export to Language page).

I will add the note about exporting to language with the Export to Language PR (since this one will be merged first)

GaurabAryal

A couple of minor things!

GaurabAryal · 2024-12-06T17:47:14Z

source/index.txt

   Connect </connect>
   Manage Data </databases-collections>
   Explore with Playgrounds </playgrounds>
+   Test Queries </copilot-export-test>


Sorry for the miscommunication here @ltran-mdb2 – I meant to put this under "Explore with Playgrounds" tab, same level as "Export to Language".

Could we also include the word "Driver" in here? We can call it "Test Driver Queries"

GaurabAryal · 2024-12-06T17:47:53Z

source/playgrounds.txt


+.. note::
+
+   You can also open a new playground to test and export queries with the


Could we also add this note at the top of the "Export to Language" page? That feature now exclusively requires our Copilot extension.

GaurabAryal

LGTM, thank you!

DOCSP-44687 export to playground with Copilot

4f18574

ltran-mdb2 added 3 commits December 4, 2024 11:35

DOCSP-44687 export to playground with Copilot

422b4d3

DOCSP-44687 fixing spacing

f0f7758

DOCSP-44687 fixing spacing

e0ac6ad

sarah-olson-mongodb approved these changes Dec 4, 2024

View reviewed changes

DOCSP-44687 copy edits

54aac61

GaurabAryal suggested changes Dec 5, 2024

View reviewed changes

ltran-mdb2 added 5 commits December 6, 2024 10:15

DOCSP-44687 moving feature to new page

6f4891b

DOCSP-44687 moving feature to new page

eaa9840

DOCSP-44687 moving feature to new page

1235acc

DOCSP-44687 moving feature to new page

dd324ed

DOCSP-44687 moving feature to new page

235ea3a

GaurabAryal suggested changes Dec 6, 2024

View reviewed changes

ltran-mdb2 added 5 commits December 6, 2024 15:05

DOCSP-44687 tech edits

b1cf4c2

DOCSP-44687 tech edits

4edadd0

DOCSP-44687 tech edits

c363216

DOCSP-44687 tech edits

2368cd1

DOCSP-44687 tech edits

1c48330

ltran-mdb2 requested a review from GaurabAryal December 6, 2024 20:41

GaurabAryal approved these changes Dec 6, 2024

View reviewed changes

ltran-mdb2 merged commit 38b040c into mongodb:master Dec 9, 2024
4 of 5 checks passed


		1. Open a project file.

		To open a file in \|vscode-short\|, click on the file name in the


		#. Highlight the code that you want to open in a playground.

		#. Right click to select :guilabel:`Export Code to Playground`.


		.. include:: /includes/steps/open-new-playground.rst

		.. tab:: Your Project File


		.. note::

		You can also open a new playground to test and export queries with the

DOCSP-44687 export to playground with Copilot #103

DOCSP-44687 export to playground with Copilot #103

Uh oh!

Conversation

ltran-mdb2 commented Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

STAGING

JIRA

Self-Review Checklist

External Review Requirements

Uh oh!

netlify bot commented Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-mongodb-vscode ready!

Uh oh!

sarah-olson-mongodb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaurabAryal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaurabAryal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ltran-mdb2 commented Dec 4, 2024 •

edited

Loading

netlify bot commented Dec 4, 2024 •

edited

Loading